Skip to content

Conversation

@santiagoars
Copy link
Contributor

UPDATE ORDS SAMPLE APP DOCUMENTATION FOR THE AUTHENTICATION CHANGES

## Description
A couple of changes were made in the following PR: https://github.com/oracle/create-database-app/pull/156
  1. The enduser endpoints are no longer protected, thus Basic authentication is no longer being used to execute those endpoints. This means that a non-logged user can now access all non-admin features of the sample app, including the discovery feature. Below is the difference between a non-logged user's headers and a logged user's headers for the same request:
    Non-logged user
    { 'Content-Type': 'application/json', Accept: 'application/json' }
    Logged user
    { 'Content-Type': 'application/json', Accept: 'application/json', Authorization: 'Bearer <token_here>' }
  2. Privileges were removed from the AUTORest Enabled Views that are used for the discover feature. Auth is no longer required. This means that they can be accessed by any non-logged user and they can search for any artist, venue or concert they desire.
  3. The SQL exports and the Open API exports were updated to reflect the changes described in items 1 and 2. I was able to verify that the new files work just fine by executing them directly in Database Actions and checking that our objects were created correctly.

In order to fully finish this task, a couple of changes to documentation are required. Here's a list of the changes that were made to the documentation to reflect the changes made in the previous PR:

For the Protecting Our Endpoints notes:

  • Remove the mention of /euser/*
  • Remove the concert_app_euser privilege from the code snippet
  • Change the three privileges part to two privileges. Explain that there is no need for a third privilege in the euser case, as euser can only access publicly available URL's.

For Third Step: Grant permissions to the recently created API.

  • Remove the SEARCH AR views from the table.
  • Remove the concert_app_euser privilege from the table.
  • Replace the image for the permissions

For ORDS Concert App - Defining and Creating the RESTful services 

  • add a section to explain that the concert_app.euser.v1 module is public.

    Type of change

    • Bug fix (non-breaking change which fixes an issue)
    • New feature (non-breaking change which adds functionality)
    • Breaking change (fix or feature that would cause existing functionality to not work as expected)
    • This change requires a documentation update

    Checklist:

    • My code follows the style guidelines of this project
    • I have performed a self-review of my own code
    • I have commented my code, particularly in hard-to-understand areas
    • I have made corresponding changes to the documentation
    • My changes generate no new warnings/errors
    • I have added tests that prove my fix is effective or that my feature works
    • New and existing unit tests pass locally with my changes

@oracle-contributor-agreement oracle-contributor-agreement bot added the OCA Verified All contributors have signed the Oracle Contributor Agreement. label Dec 17, 2024
@santiagoars santiagoars requested a review from oiramS December 17, 2024 21:59
oiramS
oiramS previously approved these changes Dec 18, 2024
Copy link
Contributor

@oiramS oiramS left a comment

Choose a reason for hiding this comment

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

LGTM!

@dbtools-antcampo dbtools-antcampo merged commit f427b50 into main Dec 19, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

OCA Verified All contributors have signed the Oracle Contributor Agreement.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants