-
Notifications
You must be signed in to change notification settings - Fork 40
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(general): minutes and API template
Signed-off-by: Mark Sanders <[email protected]>
- Loading branch information
Showing
3 changed files
with
145 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# TEMPLATE (Name of API) API | ||
|
||
High Level Description of the API in this area. | ||
|
||
## Reference Implementations | ||
|
||
Include reference implementations in this section | ||
|
||
_All implementations herein above are for reference only and __not__ meant to be used as-is in production_ | ||
|
||
## Clients | ||
|
||
The available clients for the API are: | ||
see <https://github.com/opiproject/pydpu> and <https://github.com/opiproject/godpu> for clients | ||
|
||
(_The API implementation should add support in the clients for the interface though both clients may not have the support at the same time_) | ||
|
||
## Demos | ||
|
||
Include references to any demos in this section | ||
|
||
## Additional Information related to the API | ||
|
||
Include topic areas such as below (These would become headings in this documentation section). Replace this section header with the Header(s) for the additions that are being added: | ||
|
||
- Use Case Examples | ||
- Use Case #1 | ||
- Use Case #2 | ||
- Implementation/Architecture/Infrastructure View of API | ||
- Provisioning Aspects | ||
- Pipeline Flow of relationships | ||
- Management Aspects | ||
- References |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
# Minutes/Topics September 2023 | ||
|
||
--- | ||
|
||
## Sept 7 | ||
|
||
Topics Covered: | ||
|
||
- Discuss PR#343 <https://github.com/opiproject/opi-api/pull/343> - Still pending | ||
- Discuss Announcements on API changes for checking and linter | ||
- Networking Workshop Timing Planning | ||
- Review Issues and Pending PRs in Github | ||
- Documentation for API areas (Template needed) | ||
- Requirements for moving APIs from Alpha to Beta | ||
|
||
Notes: | ||
|
||
- Alignment to Google AIP - objects need name field and string | ||
- Name enforcement, and name field can't be set by the customer unless it is not generated by the system. | ||
- Change from output only to IDENTIFIER | ||
- API Networking Workgroup - In Person - September | ||
- Week of Sept 18th - Start at 8:00am PT to accomodate EU and other timezones as much as possible | ||
- Agenda for meeting to propose | ||
- Documentation Template view for API definitions | ||
- Github.com/opiproject/opi-api/tree/main/storage as an initial example | ||
- API Template needs to have common look and feel with area for details to be added | ||
- Open an issue for Template Format of Documentation - Complete | ||
- Requirements for moving Alpha APIs to Beta view - Need a PR for putting that together. | ||
- Open an issue for API transitions - Complete | ||
- Completed PR review - cleaned up several older items. | ||
- Issues review | ||
- Several need to be in discussion topics. Specifically: | ||
- #53 | ||
- #142 | ||
- #211 | ||
- #323 | ||
- #332 needs to be taken up with the protoc-gen-grpc-gateway community | ||
- We need people to take up issues and have them assigned to them to address. | ||
- Use the github discussions to work through various issues in collaborative environment along with slack channel. | ||
|
||
Recording at: <https://zoom.us/rec/share/bOuZV5zTTHgIqncjHUpEUhQ5rnMb8ow5jpnKxF75gBL32OYe53zNcNC382in2R5m.4qtLeqGXzwN0MkQV> | ||
|
||
--- | ||
|
||
## Sept 14 | ||
|
||
Topics Planned: | ||
|
||
- Discuss PR#343 <https://github.com/opiproject/opi-api/pull/343> - Still pending. | ||
|
||
Notes: | ||
|
||
Recording at: | ||
|
||
--- |