Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adr for conceptual view #1190

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

JimFuller-RedHat
Copy link
Collaborator

@JimFuller-RedHat JimFuller-RedHat commented Jan 23, 2025

going to need help fleshing out the rest api ...

@JimFuller-RedHat JimFuller-RedHat self-assigned this Jan 23, 2025
@JimFuller-RedHat JimFuller-RedHat force-pushed the adr-analysis-conceptual branch 16 times, most recently from c0bb407 to 7bc6b02 Compare January 23, 2025 12:58
docs/adrs/00002-analysis-graph.md Outdated Show resolved Hide resolved
docs/adrs/00002-analysis-graph.md Show resolved Hide resolved
@chirino
Copy link
Contributor

chirino commented Jan 23, 2025

I like it. We should consider if there are better terms to use than ancestor and descendant as these could get associated with the AncestorOf relationship. Maybe:

  • relationship - reverse-relationship
  • forward - reverse
  • normal and inverse

If the ancestor and descendant fields found in the response are optional then the same return type can be used for all these API endpoints. If that's the case then I think we could consolidate to a single api/v2/analysis/relationships endpoint if it accepts arg filters like:

  • ancestors bool
  • descendants bool
  • depth: int
  • realtionshipType: string

@JimFuller-RedHat
Copy link
Collaborator Author

I like it. We should consider if there are better terms to use than ancestor and descendant as these could get associated with the AncestorOf relationship. Maybe:

* `relationship` - `reverse-relationship`

* `forward` - `reverse`

* `normal` and `inverse`

In the graph world this conversation comes up regularly ... I always settle on anc/desc as most people agree what it means.

If the ancestor and descendant fields found in the response are optional then the same return type can be used for all these API endpoints. If that's the case then I think we could consolidate to a single api/v2/analysis/relationships endpoint if it accepts arg filters like:

* ancestors bool

* descendants bool

* depth: int

* realtionshipType: string

I am all for simplifying and/or having less 'moving parts' ... even better when parameterised ... in this case I suggested separation because it was easier to puzzle out ... lets discuss this in meeting.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants