Skip to content

Rework api documentation for better code generation #1419

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.

Sign up for GitHub

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

Merged
christianlupus merged 3 commits into from
Jan 14, 2023
Merged

Rework api documentation for better code generation #1419

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b4bd9ef
annotate DateTime fields in the api to improve code generation
Jan 5, 2023
8f134aa
Use oneOf to indicate multiple possible types
Jan 6, 2023
b7a3b15
Add API changelog and changelog
christianlupus Jan 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Add API changelog and changelog 
Signed-off-by: Christian Wolf <github@christianwolf.email>
  • Loading branch information
@christianlupus
christianlupus committed Jan 14, 2023
commit b7a3b15f2c884b9b273346e9f57a125cce142f24
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@
- Migrate the dev environment to [docker-dev by Julius Haertl](https://github.com/juliushaertl/nextcloud-docker-dev)
[#1440](https://github.com/nextcloud/cookbook/pull/1440) @christianlupus

## Documentation
- Fixed some issues in the API description


## 0.10.1 - 2022-11-09

Expand Down
6 changes: 6 additions & 0 deletions docs/dev/api/changelog/0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,12 @@ The duplicated (deprecated) endpoints in v0.9.15 are removed.
Any endpoints not under `/webapp/` or `/api/v1/` are no longer working.
See also [the section](#split-and-rename-api-endpoints).

### Fix OpenAPI format specification
There were some minor flaws in the spec file.
These flaws caused some code generation tools to fail or produce incomplete results.

The fixture of these issues should not be critical as these are mainly cosmetic and will __not__ change the actual transmitted data.


## Version 0.1.0 - cookbook v0.9.15 - 2022-09-08

Expand Down