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

Embed documentation in API Spec #38

Merged

Conversation

monamok
Copy link
Collaborator

@monamok monamok commented Jun 5, 2023

What type of PR is this?

  • documentation

What this PR does / why we need it:

Update API documentation according to v0.3.0 API version definition. The documentation will be added to the API definition as discussed in camaraproject/WorkingGroups#164. It was agreed that the CAMARA documentation should be embedded in the OAS definition and not separate. This will reduce the effort to maintain the documentation.

This PR is aligned to QualityOnDemand PR camaraproject/QualityOnDemand#151

Which issue(s) this PR fixes:

Fixes #37

Special notes for reviewers:

  • Multi-line descriptions formatted as |
  • UML diagram added in order to clarify the end-to-end flow
  • External resources such as images and other docs are linked to the absolute paths in Github: ![Alt text](https://full_path?raw=true)
  • As for linking images the absolute paths are required and the UML file still doesn't exist in CAMARA repository for the moment the link from my repository is being used. Once the PR is merged, another PR must be opend to change the UML URL that is created in the main branch.

Visualizations tested with editor.swagger.io

Copy link
Collaborator

@DT-DawidWroblewski DT-DawidWroblewski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

auth call very high level, but overall sequence is good

@DT-DawidWroblewski DT-DawidWroblewski merged commit f751609 into camaraproject:main Jun 15, 2023
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.

Embedded documentation in API Spec accroding to commonalities agreements
2 participants