Skip to content

Commit 0b6a451

Browse files
committed
Added schema to readme
1 parent 6148255 commit 0b6a451

File tree

2 files changed

+13
-18
lines changed

2 files changed

+13
-18
lines changed

LaravelDoctrineApiKey.skipper

Lines changed: 6 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?xml version="1.0"?>
22
<skipper version="3.2.36.1772" mvc="Without MVC" orm="Doctrine2" name="doctrine-apikey" uuid="853f158e-72be-49b9-9f8c-ffef53333777">
3-
<module name="\MainBundle" local-name="MainBundle" namespace="\ApiSkeletons\Laravel\Doctrine\ApiKey\Entity" local-namespace="ApiSkeletons\Laravel\Doctrine\ApiKey\Entity" export-format="Doctrine2Xml" export-path="config/orm" uuid="5bbfe5b4-7579-44ee-81f9-fa036ee071a3">
3+
<module name="\ApiKey" local-name="ApiKey" namespace="\ApiSkeletons\Laravel\Doctrine\ApiKey\Entity" local-namespace="ApiSkeletons\Laravel\Doctrine\ApiKey\Entity" export-format="Doctrine2Xml" export-path="config/orm" uuid="5bbfe5b4-7579-44ee-81f9-fa036ee071a3">
44
<entity name="\ApiSkeletons\Laravel\Doctrine\ApiKey\Entity\ApiKey" local-name="ApiKey" namespace="\ApiSkeletons\Laravel\Doctrine\ApiKey\Entity" uuid="5d41775f-e84c-4890-a202-19c4f93e3b58">
55
<field name="id" type="bigint" required="true" unique="true" primary="true" auto-increment="true" uuid="1425ce9b-57d6-4c28-bd8b-89fffce92468"/>
66
<field name="name" type="string" required="true" unique="true" uuid="a0ea0895-aab4-4c93-b119-47c9539e95a2"/>
@@ -67,32 +67,22 @@
6767
<module name="\Legend" local-name="Legend" namespace="\" export-format="Doctrine2Xml" export-path="config/orm" uuid="ccf18b55-8155-4892-9489-ea177a3f2a0d">
6868
<comment caption="Author" description="Tom H Anderson&#10;API Skeletons&#10;&lt;contact@apiskeletons.com&gt;" uuid="c405b7e9-3ab9-4ffd-8cd4-2c5621b85da4"/>
6969
<comment caption="About" description="API key registry for Laravel Doctrine" uuid="4fb53591-1ee9-4a3b-a3ee-7d63994a1d4c"/>
70-
<comment caption="Comment" uuid="b0c79b08-a4e6-4d29-9603-e390bbd53422"/>
7170
<comment caption="Copyright" description="API Skeletons, 2021&#10;Licensed under the MIT open source license" uuid="d5384c1f-e65f-4128-8c4d-860b6a578102"/>
72-
<comment caption="Fixture" uuid="ab1e4d63-5c52-44c9-aa55-7c3f56e778ed"/>
73-
<comment caption="Fixture Data" uuid="8dead80e-ac10-46f1-b376-8bd7322aa6dd"/>
74-
<comment caption="Business Rule" uuid="4af1b7fe-6a7c-47af-a4e8-2cf457f8c96f"/>
75-
<comment caption="Idea" uuid="bf1783ed-22fb-40a8-9fbd-43071bafbd7f"/>
7671
</module>
7772
<visual-data>
7873
<association uuid="056be1e5-0677-44ad-8f6f-1b4023eb9a7d" caption1-position-x="0" caption1-position-y="0" center-position-x="0" center-position-y="0" color="#969696"/>
7974
<association uuid="c997c4aa-195c-4f0e-8a32-5506f53f0ab9" caption1-position-x="0" caption1-position-y="0" center-position-x="0" center-position-y="0" color="#969696"/>
80-
<comment uuid="4af1b7fe-6a7c-47af-a4e8-2cf457f8c96f" bg-color="#BCF2A9" position-x="220" position-y="200" size-x="0" size-x2="80" size-y="0" size-y2="20" txt-color="#000000"/>
8175
<comment uuid="4fb53591-1ee9-4a3b-a3ee-7d63994a1d4c" bg-color="#FFFFE0" position-x="20" position-y="20" size-x="0" size-x2="152" size-y="0" size-y2="30" txt-color="#000000"/>
82-
<comment uuid="8dead80e-ac10-46f1-b376-8bd7322aa6dd" bg-color="#A0ECDD" position-x="120" position-y="200" size-x="0" size-x2="80" size-y="0" size-y2="20" txt-color="#000000"/>
83-
<comment uuid="ab1e4d63-5c52-44c9-aa55-7c3f56e778ed" bg-color="#0BC0A9" position-x="20" position-y="200" size-x="0" size-x2="80" size-y="0" size-y2="20" txt-color="#000000"/>
84-
<comment uuid="b0c79b08-a4e6-4d29-9603-e390bbd53422" bg-color="#FFFFE0" position-x="20" position-y="160" size-x="0" size-x2="80" size-y="0" size-y2="20" txt-color="#000000"/>
85-
<comment uuid="bf1783ed-22fb-40a8-9fbd-43071bafbd7f" bg-color="#D587FF" position-x="120" position-y="160" size-x="0" size-x2="80" size-y="0" size-y2="20" txt-color="#000000"/>
86-
<comment uuid="c405b7e9-3ab9-4ffd-8cd4-2c5621b85da4" bg-color="#FFFFE0" position-x="426" position-y="157" size-x="6" size-x2="134" size-y="-3" size-y2="63" txt-color="#000000"/>
76+
<comment uuid="c405b7e9-3ab9-4ffd-8cd4-2c5621b85da4" bg-color="#FFFFE0" position-x="216" position-y="17" size-x="6" size-x2="134" size-y="-3" size-y2="63" txt-color="#000000"/>
8777
<comment uuid="d5384c1f-e65f-4128-8c4d-860b6a578102" bg-color="#FFFFE0" position-x="399" position-y="20" size-x="9" size-x2="168" size-y="0" size-y2="60" txt-color="#000000"/>
88-
<entity uuid="3affb470-569a-4814-9456-e72403fe11d1" bg-color="#FFFFFF" hdr-color="#D2D2D2" position-x="645" position-y="45" size-x="0" size-x2="112" size-y="0" size-y2="101"/>
78+
<entity uuid="3affb470-569a-4814-9456-e72403fe11d1" bg-color="#FFFFFF" hdr-color="#D2D2D2" position-x="577" position-y="51" size-x="0" size-x2="109" size-y="0" size-y2="87"/>
8979
<entity uuid="5d41775f-e84c-4890-a202-19c4f93e3b58" bg-color="#FFFFFF" hdr-color="#D2D2D2" position-x="337" position-y="43" size-x="0" size-x2="112" size-y="0" size-y2="115"/>
90-
<entity uuid="69a65682-1289-49d8-a90b-4354347cb63a" bg-color="#FFFFFF" hdr-color="#D2D2D2" position-x="25" position-y="46" size-x="0" size-x2="112" size-y="0" size-y2="101"/>
80+
<entity uuid="69a65682-1289-49d8-a90b-4354347cb63a" bg-color="#FFFFFF" hdr-color="#D2D2D2" position-x="77" position-y="51" size-x="0" size-x2="109" size-y="0" size-y2="87"/>
9181
<entity uuid="b9c06238-4131-4393-b380-09fd0e013f59" bg-color="#FFFFFF" hdr-color="#D2D2D2" position-x="343" position-y="207" size-x="0" size-x2="100" size-y="0" size-y2="60"/>
9282
<entity uuid="e2fc4483-5bba-4764-81cb-ca00f3a97ee2" bg-color="#FFFFFF" hdr-color="#D2D2D2" position-x="337" position-y="325" size-x="0" size-x2="112" size-y="0" size-y2="73"/>
9383
<many-to-many-association uuid="f3287250-6321-4387-b98d-40b7df23f443" color="#969696"/>
94-
<module uuid="5bbfe5b4-7579-44ee-81f9-fa036ee071a3" bg-color="#E1EDF0" position-x="23" position-y="302" size-x="11" size-x2="817" size-y="22" size-y2="428"/>
95-
<module uuid="ccf18b55-8155-4892-9489-ea177a3f2a0d" bg-color="#E8FADF" position-x="10" position-y="20" size-x="0" size-x2="583" size-y="0" size-y2="233"/>
84+
<module uuid="5bbfe5b4-7579-44ee-81f9-fa036ee071a3" bg-color="#E1EDF0" position-x="-49" position-y="116" size-x="-57" size-x2="709" size-y="-18" size-y2="398"/>
85+
<module uuid="ccf18b55-8155-4892-9489-ea177a3f2a0d" bg-color="#E8FADF" position-x="8" position-y="20" size-x="0" size-x2="582" size-y="0" size-y2="100"/>
9686
<project uuid="853f158e-72be-49b9-9f8c-ffef53333777" size-x="10" size-x2="1098" size-y="0" size-y2="810"/>
9787
</visual-data>
9888
</skipper>

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
[![License](https://poser.pugx.org/api-skeletons/laravel-doctrine-apikey/license)](//packagist.org/packages/api-skeletons/laravel-doctrine-apikey)
88

99
This repository provides a driver for Doctrine which can be added to an existing entity manager.
10-
The driver provies a set of entities which enable ApiKey authorization through HTTP middleware.
10+
The driver provides a set of entities which enable ApiKey authorization through HTTP middleware.
1111
Scopes are supported! This was the missing piece of other repositories which catalyzed the creation of this library.
1212

1313
## Installation
@@ -66,6 +66,11 @@ Authorization: Bearer {key}
6666
```
6767

6868

69+
## Schema
70+
71+
![Screen Shot 2021-12-17 at 12 20 03 AM](https://user-images.githubusercontent.com/493920/146505347-09778bde-9fff-4c46-819d-fbf2e83d3ad2.png)
72+
73+
6974
## Using Scopes
7075

7176
Scopes are permissions for ApiKeys. They are commonly used in OAuth2 and are less common in ApiKeys.
@@ -137,7 +142,7 @@ method of maintaining data in the second object manager. In order
137142
to use multiple object managers you must do some configuration. Assuming you followed the Quick Start, above,
138143
follow these steps for a second object manager:
139144

140-
Create a new singleton of the ApiKeyService with a differnet name in `App\Providers\AppServiceProvider`
145+
Create a new singleton of the ApiKeyService with a different name in `App\Providers\AppServiceProvider`
141146
```php
142147
use ApiSkeletons\Laravel\Doctrine\ApiKey\Service\ApiKeyService;
143148

0 commit comments

Comments
 (0)