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

APIv4 initial documentation #126

Closed
wants to merge 2 commits into from
Closed

APIv4 initial documentation #126

wants to merge 2 commits into from

Conversation

davlgd
Copy link
Collaborator

@davlgd davlgd commented Jan 5, 2024

Checklist

  • My PR is related to an opened issue : #

⚠️ If changes affect GitHub Action files

  • I have added tests to cover my changes : link

Pull request type

Please check the type of change your PR introduces:

  • Documentation content changes
  • Bugfix on the site
  • Build related changes
  • Other (please describe):

Description

We start to use APIv4 for many services and want to document it for customers in addition to existing APIv2. As OpenAPI is not ready yet, we've prepared a manually written page. It's content has been checked and validated by all impacted teams.

Why is this needed?

We'll push API usage through multiple tools and need to start documenting APIv4

Reviewes

Who should review these changes? @juliamrch @miton18

@davlgd davlgd self-assigned this Jan 5, 2024
@davlgd davlgd temporarily deployed to PR review apps January 5, 2024 14:02 — with GitHub Actions Inactive
@davlgd davlgd requested review from miton18 and juliamrch January 5, 2024 14:02
Copy link

github-actions bot commented Jan 5, 2024

Deployment has finished 👁️👄👁️ Your app is available here

content/openapi.md Outdated Show resolved Hide resolved
content/openapiv4.md Outdated Show resolved Hide resolved
content/openapiv4.md Outdated Show resolved Hide resolved
content/openapiv4.md Show resolved Hide resolved
content/openapiv4.md Outdated Show resolved Hide resolved
miton18
miton18 previously approved these changes Jan 5, 2024
Copy link

github-actions bot commented Jan 8, 2024

Your review app has been deleted 👋

Copy link

github-actions bot commented Jan 8, 2024

Deployment has finished 👁️👄👁️ Your app is available here

@juliamrch juliamrch added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 10, 2024
Copy link

🚀 Your app has been updated and is available here

@juliamrch
Copy link
Collaborator

Fixed by PR #165

Thanks for your collaboration !

@juliamrch juliamrch closed this Jan 26, 2024
@juliamrch juliamrch deleted the davlgd-apiv4 branch January 26, 2024 17:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants