Add documentation about integrating APIs with security

[ohltyler]

Signed-off-by: Tyler Ohlsen [email protected]

opensearch-security pull request intake form

Please provide as much details as possible to get feedback/acceptance on your PR quickly

1. Category: (Enhancement, New feature, Bug fix, Test fix, Refactoring, Maintenance, Documentation)
   Documentation

2. Github Issue # or road-map entry, if available:
   N/A

3. Description of changes:
   Adding a section in the README with instructions on how to onboard/integrate new APIs with security.

4. Why these changes are required?
   For consistency and faster development of different plugins wanting to integrate new or existing APIs with security.

5. What is the old behavior before changes and new behavior after changes? (Please add any example/logs/screen-shot if available)
   N/A

6. Testing done: (Please provide details of testing done: Unit testing, integration testing and manual testing)
   N/A

7. TO-DOs, if any: (Please describe pending items and provide Github issues# for each of them)
   N/A

8. Is it backport from main branch? (If yes, please add backport PR # and commits #)
   N/A

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or

(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or

(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.

(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

[davidlago]

Thanks for the PR @ohltyler. Apologies for the long delay in the review... especially as we've since updated the README :( Could you please update to move section down right before the Contributing header as git auto-resolving the conflicts is placing it at the very beginning? Thanks!

[ohltyler]

Thanks for the PR @ohltyler. Apologies for the long delay in the review... especially as we've since updated the README :( Could you please update to move section down right before the Contributing header as git auto-resolving the conflicts is placing it at the very beginning? Thanks!

Done!

[codecov-commenter]

Codecov Report

Merging #1460 (2c7eb61) into main (61869e7) will decrease coverage by 0.04%.
The diff coverage is n/a.

@@             Coverage Diff              @@
##               main    #1460      +/-   ##
============================================
- Coverage     64.66%   64.62%   -0.05%     
+ Complexity     3220     3218       -2     
============================================
  Files           247      247              
  Lines         17351    17351              
  Branches       3082     3082              
============================================
- Hits          11220    11213       -7     
- Misses         4581     4588       +7     
  Partials       1550     1550              

Impacted Files	Coverage Δ
...ecurity/configuration/ConfigurationRepository.java	73.07% <0.00%> (-2.20%)	⬇️
...security/configuration/DlsFlsFilterLeafReader.java	59.76% <0.00%> (-0.71%)	⬇️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 61869e7...2c7eb61. Read the comment docs.

[cliu123]

Are we having similar content in all plugins README? If so, is there any issue tracking this effort to apply these documentation changes consistently on all plugins?

[ohltyler]

I don't believe this is documented in any plugins. The idea of adding it here, is so all plugins can have a central place to refer to.

[peternied]

I think this is a good starting point, lets add it for now and then we can figure out the best mechanism to get this information out.

@ohltyler Could you create a follow up issue in the plugins repo to track centralized practices / tutorial / documentation that would make sense to link this to?

[ohltyler]

I think this is a good starting point, lets add it for now and then we can figure out the best mechanism to get this information out.

@ohltyler Could you create a follow up issue in the plugins repo to track centralized practices / tutorial / documentation that would make sense to link this to?

I like this idea, created a tracking issue in opensearch-plugins and assigned myself - opensearch-project/opensearch-plugins#146

[peternied]

@ohltyler Looks like we need this change to be rebased so it can pass all of our new CI systems, could you do that so we can merge?

[cliu123]

audit/compliance-logging instead?

[ohltyler]

why? This is auto-generated with prettier

[cliu123]

The format auditcompliance-logging looks different from other items. If only this format will work, then let's go with it.